Micro Pump Click Driver

API for configuring and manipulating Micro Pump Click driver. More...

Topics
	Micro Pump Settings
	Settings of Micro Pump Click driver.
	Micro Pump MikroBUS Map
	MikroBUS pin mapping of Micro Pump Click driver.

Functions
void	micropump_cfg_setup (micropump_cfg_t *cfg)
	Micro Pump configuration object setup function.
err_t	micropump_init (micropump_t *ctx, micropump_cfg_t *cfg)
	Micro Pump initialization function.
err_t	micropump_read_adc_raw (micropump_t *ctx, uint16_t *data_out)
	Micro Pump read AN pin value function.
err_t	micropump_read_adc_voltage (micropump_t *ctx, float *data_out)
	Micro Pump read AN pin voltage level function.
err_t	micropump_read_adc_voltage_avg (micropump_t *ctx, uint16_t num_conv, float *voltage_avg)
	Micro Pump read AN pin voltage level average function.
err_t	micropump_set_vref (micropump_t *ctx, float vref)
	Micro Pump set vref function.
void	micropump_set_in1_pin (micropump_t *ctx)
	Micro Pump set IN1 pin function.
void	micropump_clear_in1_pin (micropump_t *ctx)
	Micro Pump clear IN1 pin function.
void	micropump_set_in2_pin (micropump_t *ctx)
	Micro Pump set IN2 pin function.
void	micropump_clear_in2_pin (micropump_t *ctx)
	Micro Pump clear IN2 pin function.
void	micropump_drive_motor (micropump_t *ctx, uint8_t state)
	Micro Pump drive motor function.
err_t	micropump_calib_offset (micropump_t *ctx)
	Micro Pump calib offset function.
err_t	micropump_get_out_current (micropump_t *ctx, float *current)
	Micro Pump get out current function.

Detailed Description

API for configuring and manipulating Micro Pump Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

micropump_calib_offset()

err_t micropump_calib_offset

(

micropump_t *

ctx

)

Micro Pump calib offset function.

This function calibrates the zero current offset value.

Parameters

[in]

ctx

: Click context object. See micropump_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

micropump_cfg_setup()

void micropump_cfg_setup

(

micropump_cfg_t *

cfg

)

Micro Pump configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See micropump_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

micropump_clear_in1_pin()

void micropump_clear_in1_pin

(

micropump_t *

ctx

)

Micro Pump clear IN1 pin function.

This function clears the IN1 pin to low logic state.

Parameters

[in]

ctx

: Click context object. See micropump_t object definition for detailed explanation.

Returns

None.

Note

None.

micropump_clear_in2_pin()

void micropump_clear_in2_pin

(

micropump_t *

ctx

)

Micro Pump clear IN2 pin function.

This function clears the IN2 pin to low logic state.

Parameters

[in]

ctx

: Click context object. See micropump_t object definition for detailed explanation.

Returns

None.

Note

None.

micropump_drive_motor()

void micropump_drive_motor	(	micropump_t *	ctx,
		uint8_t	state )

Micro Pump drive motor function.

This function drives the micro pump motor in the selected state.

Parameters

[in]	ctx	: Click context object. See micropump_t object definition for detailed explanation.
[in]	state	: 0 - Coast, 1 - Forward, 2 - Reverse, 3 - Brake.

Returns

None.

Note

None.

micropump_get_out_current()

err_t micropump_get_out_current	(	micropump_t *	ctx,
		float *	current )

Micro Pump get out current function.

This function reads the current output measurement in mA.

Parameters

[in]	ctx	: Click context object. See micropump_t object definition for detailed explanation.
[out]	current	: Current output level [mA].

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

This function relies on calibrated zero current offset, see micropump_calib_offset function.

micropump_init()

err_t micropump_init	(	micropump_t *	ctx,
		micropump_cfg_t *	cfg )

Micro Pump initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See micropump_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See micropump_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

micropump_read_adc_raw()

err_t micropump_read_adc_raw	(	micropump_t *	ctx,
		uint16_t *	data_out )

Micro Pump read AN pin value function.

This function reads results of AD conversion of the AN pin.

Parameters

[in]	ctx	: Click context object. See micropump_t object definition for detailed explanation.
[out]	data_out	: Output ADC result.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

micropump_read_adc_voltage()

err_t micropump_read_adc_voltage	(	micropump_t *	ctx,
		float *	data_out )

Micro Pump read AN pin voltage level function.

This function reads results of AD conversion of the AN pin and converts them to proportional voltage level.

Parameters

[in]	ctx	: Click context object. See micropump_t object definition for detailed explanation.
[out]	data_out	: Output voltage level of the analog pin [V].

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

The conversion to voltage depends on the entered configuration of the ADC (resolution, reference voltage).

micropump_read_adc_voltage_avg()

err_t micropump_read_adc_voltage_avg	(	micropump_t *	ctx,
		uint16_t	num_conv,
		float *	voltage_avg )

Micro Pump read AN pin voltage level average function.

This function a desired number of ADC voltage samples and averages it.

Parameters

[in]	ctx	: Click context object. See micropump_t object definition for detailed explanation.
[in]	num_conv	: Number of ADC samples.
[out]	voltage_avg	: Average output voltage level [V].

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

The conversion to voltage depends on the entered configuration of the ADC (resolution, reference voltage).

micropump_set_in1_pin()

void micropump_set_in1_pin

(

micropump_t *

ctx

)

Micro Pump set IN1 pin function.

This function sets the IN1 pin to high logic state.

Parameters

[in]

ctx

: Click context object. See micropump_t object definition for detailed explanation.

Returns

None.

Note

None.

micropump_set_in2_pin()

void micropump_set_in2_pin

(

micropump_t *

ctx

)

Micro Pump set IN2 pin function.

This function sets the IN2 pin to high logic state.

Parameters

[in]

ctx

: Click context object. See micropump_t object definition for detailed explanation.

Returns

None.

Note

None.

micropump_set_vref()

err_t micropump_set_vref	(	micropump_t *	ctx,
		float	vref )

Micro Pump set vref function.

This function sets the voltage reference for Micro Pump Click driver.

Parameters

[in]	ctx	: Click context object. See micropump_t object definition for detailed explanation.
[in]	vref	: Reference voltage (volts).

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

The default voltage reference set with micropump_init is 3.3V.